<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Dimble's Playground » \RGenerator</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Dimble's Playground</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Auth.html"><i class="icon-folder-open"></i> Auth</a></li>
<li><a href="../packages/Database.html"><i class="icon-folder-open"></i> Database</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Infraestructure.html"><i class="icon-folder-open"></i> Infraestructure</a></li>
<li><a href="../packages/Rights.html"><i class="icon-folder-open"></i> Rights</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">418</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_addItems" title="addItems() :: Appends items to be generated of a specific type."><span class="description">Appends items to be generated of a specific type.</span><pre>addItems()</pre></a></li>
<li class="method public "><a href="#method_getControllerActions" title="getControllerActions() :: Returns all the controllers and their actions."><span class="description">Returns all the controllers and their actions.</span><pre>getControllerActions()</pre></a></li>
<li class="method public "><a href="#method_init" title="init() :: Initializes the generator."><span class="description">Initializes the generator.</span><pre>init()</pre></a></li>
<li class="method public "><a href="#method_run" title="run() :: Runs the generator."><span class="description">Runs the generator.</span><pre>run()</pre></a></li>
</ul>
</li>
<li class="nav-header protected">» Protected
                    <ul>
<li class="method protected "><a href="#method_getAllControllers" title="getAllControllers() :: Returns a list of all application controllers."><span class="description">Returns a list of all application controllers.</span><pre>getAllControllers()</pre></a></li>
<li class="method protected "><a href="#method_getControllersInModules" title="getControllersInModules() :: Returns all the controllers under the specified path."><span class="description">Returns all the controllers under the specified path.</span><pre>getControllersInModules()</pre></a></li>
<li class="method protected "><a href="#method_getControllersInPath" title="getControllersInPath() :: Returns all controllers under the specified path."><span class="description">Returns all controllers under the specified path.</span><pre>getControllersInPath()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
                    <ul><li class="property public "><a href="#property_db" title="$db() :: "><span class="description"></span><pre>$db</pre></a></li></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property__authManager" title="$_authManager() :: "><span class="description"></span><pre>$_authManager</pre></a></li>
<li class="property private "><a href="#property__items" title="$_items() :: "><span class="description"></span><pre>$_items</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\RGenerator"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/RGenerator.html">RGenerator</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Rights generator component class file.</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:cniska@live.com">Christoffer Niska</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright &amp;copy; 2010 Christoffer Niska</td>
</tr>
<tr>
<th>since</th>
<td>0.9.8</td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/Rights.components.html">Rights\components</a></td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_addItems"></a><div class="element clickable method public method_addItems" data-toggle="collapse" data-target=".method_addItems .collapse" title="public">
<h2>Appends items to be generated of a specific type.</h2>
<pre>addItems(array $items, integer $type) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$items</h4>
<code>array</code><p>the items to be generated.</p></div>
<div class="subelement argument">
<h4>$type</h4>
<code>integer</code><p>the item type.</p></div>
</div></div>
</div>
<a id="method_getControllerActions"></a><div class="element clickable method public method_getControllerActions" data-toggle="collapse" data-target=".method_getControllerActions .collapse" title="public">
<h2>Returns all the controllers and their actions.</h2>
<pre>getControllerActions(array $items<code> = null</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$items</h4>
<code>array</code><p>the controllers and actions.</p></div>
</div></div>
</div>
<a id="method_init"></a><div class="element clickable method public method_init" data-toggle="collapse" data-target=".method_init .collapse" title="public">
<h2>Initializes the generator.</h2>
<pre>init() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_run"></a><div class="element clickable method public method_run" data-toggle="collapse" data-target=".method_run .collapse" title="public">
<h2>Runs the generator.</h2>
<pre>run() : <a href="the.html">\the</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="the.html">\the</a></code>items generated or false if failed.</div>
</div></div>
</div>
<a id="method_getAllControllers"></a><div class="element clickable method protected method_getAllControllers" data-toggle="collapse" data-target=".method_getAllControllers .collapse" title="protected">
<h2>Returns a list of all application controllers.</h2>
<pre>getAllControllers() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the controllers.</div>
</div></div>
</div>
<a id="method_getControllersInModules"></a><div class="element clickable method protected method_getControllersInModules" data-toggle="collapse" data-target=".method_getControllersInModules .collapse" title="protected">
<h2>Returns all the controllers under the specified path.</h2>
<pre>getControllersInModules(string $path) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code>string</code><p>the path.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the controllers.</div>
</div></div>
</div>
<a id="method_getControllersInPath"></a><div class="element clickable method protected method_getControllersInPath" data-toggle="collapse" data-target=".method_getControllersInPath .collapse" title="protected">
<h2>Returns all controllers under the specified path.</h2>
<pre>getControllersInPath(string $path) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code>string</code><p>the path.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the controllers.</div>
</div></div>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_db"> </a><div class="element clickable property public property_db" data-toggle="collapse" data-target=".property_db .collapse" title="public">
<h2>$db</h2>
<pre>$db </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>property</th>
<td></td>
</tr></table>
</div></div>
</div>
<a id="property__authManager"> </a><div class="element clickable property private property__authManager" data-toggle="collapse" data-target=".property__authManager .collapse" title="private">
<h2>$_authManager</h2>
<pre>$_authManager </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__items"> </a><div class="element clickable property private property__items" data-toggle="collapse" data-target=".property__items .collapse" title="private">
<h2>$_items</h2>
<pre>$_items </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br>
            generated on 2014-02-03T11:03:56-02:00.<br></footer></div>
</div>
</body>
</html>
